WriteTransformMarker(int,byte[],int,int) Method

Summary

Controls how the transform markers are used when performing a lossless transformation for certain formats.

Syntax

C++

Java

public void WriteTransformMarker( 
   int id, 
   byte[] data, 
   int dataOffset, 
   int dataLength 
)

Public Overloads Sub WriteTransformMarker( _ 
   ByVal id As Integer, _ 
   ByVal data() As Byte, _ 
   ByVal dataOffset As Integer, _ 
   ByVal dataLength As Integer _ 
)

public void writeTransformMarker(int id, byte data[], int dataOffset, int dataLength)

public: 
void WriteTransformMarker(  
   int id, 
   array<byte>^ data, 
   int dataOffset, 
   int dataLength 
)

Parameters

id
The id of the metadata marker.

data
A byte array containing the data for the metadata marker.

dataOffset
Offset into data into which to begin the read operation.

dataLength
Number of bytes to read from data.

Remarks

You should use this method to write a certain marker data into the file.

This method can be called only from within the CodecsTransformMarkerCallback passed to the Transform method.

The transform mechanism is as follows:

You call Transform.
Transform will call the CodecsTransformMarkerCallback callback passed to it for every marker contained in the source file. In the callback, you can replace markers, insert markers or allow LEADTOOLS to do the default processing (recommended).
You can override the default action for a marker by returning one of the following values from the transform callback:
- CodecsTransformMarkerAction.Default: Let LEADTOOLS perform the default action on the marker. This means the marker might (or might not) be transformed and will be written to the destination file.
- CodecsTransformMarkerAction.Ignore: This marker will be ignored (this is useful for stripping unwanted markers). You should also use this if you want to do your own transformation and write the marker yourself by calling WriteTransformMarker.
- CodecsTransformMarkerAction.Abort: Abort the process. This will cause Transform to throw a 'user-abort' exception.

Note: You can also use WriteTransformMarker to insert your own markers. The marker will be inserted before the current marker. You can call WriteTransformMarker as many times as you wish. Every call to WriteTransformMarker will insert a new marker.

Warning: Incorrect handling of the markers will generate corrupt files! Since some markers contain important information about the image (image width, height, compression method, colorspace, etc), you should use caution when working with markers.

Example

For an example, refer to Transform.

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies